Skip to content

Creating a new Survey Answer

Request

This endpoint returns structured Survey Answer objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the survey_answers top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • choices (SurveyQuestionChoice) - The selected choices associated with an answer. Only populated on single or multi choice answers.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • survey_question (SurveyQuestion) - The question that the answer is directed at.
  • survey_response (SurveyResponse) - The response that the answer is tied to.
Bodyapplication/jsonrequired
survey_answerobject
{
  "survey_answer": {
    "survey_response_id": 0,
    "survey_question_id": 0,
    "date_value": "2019-08-24",
    "string_value": "string",
    "integer_value": 0,
    "decimal_value": 0.1,
    "choice_values": [
      "string"
    ],
    "choice_ids": [
      0
    ]
  }
}

Responses

Survey Answer has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
survey_answersobject
external_referencesobject
survey_questionsobject
survey_responsesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "survey_answers": {
    "property1": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "survey_question_id": "string",
      "survey_response_id": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "survey_question_id": "string",
      "survey_response_id": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "survey_questions": {
    "property1": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "question_type": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "choice_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "question_type": "string",
      "text": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "survey_responses": {
    "property1": {
      "close_date": "2019-08-24",
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "due_date": "2019-08-24",
      "external_reference_ids": [
        "string"
      ],
      "open_date": "2019-08-24",
      "owner_id": "string",
      "respondent_id": "string",
      "status": "string",
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "survey_answer_ids": [
        "string"
      ],
      "survey_template_id": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_id": "string"
    },
    "property2": {
      "close_date": "2019-08-24",
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "due_date": "2019-08-24",
      "external_reference_ids": [
        "string"
      ],
      "open_date": "2019-08-24",
      "owner_id": "string",
      "respondent_id": "string",
      "status": "string",
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "survey_answer_ids": [
        "string"
      ],
      "survey_template_id": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_id": "string"
    }
  }
}